Rename dependency attribute is_resolved to is_pinned

Renaming the dependency attribute is_resolved to is_pinned. Output changes when we use is_resolved. Reference: #634
aboutcode-org · Dec 30, 2024 · ff2a84b · ff2a84b
1 parent 0a8ee86
commit ff2a84b
Show file tree

Hide file tree

Showing 10 changed files with 24 additions and 23 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -12,6 +12,7 @@ Docs
 ~~~~~~~~~
 
 - Update macOS installation steps by @OmkarPh in #631
+- Renamed the dependency attribute ``is_resolved`` to ``is_pinned``. See #634
 
 [v4.0.3] - 2024-08-07
 --------------------------

diff --git a/src/components/PackagesEntityDetails/DependenciesTableCols.ts.ts b/src/components/PackagesEntityDetails/DependenciesTableCols.ts.ts
@@ -33,7 +33,7 @@ export const DependenciesTableCols: DepsColDef[] = [
   },
   {
     headerName: "Resolved",
-    field: "is_resolved",
+    field: "is_pinned",
     cellRenderer: TickRenderer,
     maxWidth: 92,
   },

diff --git a/src/components/PackagesEntityDetails/DependencyEntity.tsx b/src/components/PackagesEntityDetails/DependencyEntity.tsx
@@ -37,7 +37,7 @@ const DependencyEntity = (props: DependencyEntityProps) => {
           Optional
         </Badge>
       )}
-      {dependency.is_resolved && (
+      {dependency.is_pinned && (
         <Badge pill bg="success">
           <FontAwesomeIcon icon={faCheck} /> Resolved
         </Badge>
@@ -86,7 +86,7 @@ const DependencyEntity = (props: DependencyEntityProps) => {
         ))}
       </div>
       <br />
-      {dependency.is_resolved && dependency.resolved_package && (
+      {dependency.is_pinned && dependency.resolved_package && (
         <div>
           Resolved package:
           <ReactJson

diff --git a/src/pages/DependencyInfoDash/DependencyInfoDash.tsx b/src/pages/DependencyInfoDash/DependencyInfoDash.tsx
@@ -80,7 +80,7 @@ const DependencyInfoDash = () => {
 
       packageTypeSummary.packageTypeDetails.total += deps.length;
       packageTypeSummary.resolved += deps.reduce((counter, curr) => {
-        return counter + (curr.is_resolved ? 1 : 0);
+        return counter + (curr.is_pinned ? 1 : 0);
       }, 0);
       packageTypeSummary.runtime += deps.reduce((counter, curr) => {
         return counter + (curr.is_runtime ? 1 : 0);
@@ -125,7 +125,7 @@ const DependencyInfoDash = () => {
             "id",
             "for_package_uid",
             "is_runtime",
-            "is_resolved",
+            "is_pinned",
             "is_optional",
             "datasource_id",
             "scope",
@@ -145,7 +145,7 @@ const DependencyInfoDash = () => {
 
         // Prepare chart for resolved dependencies
         const resolvedDependencies = dependencies.map((dependency) =>
-          dependency.getDataValue("is_resolved") ? "Resolved" : "Unresolved"
+          dependency.getDataValue("is_pinned") ? "Resolved" : "Unresolved"
         );
         const { chartData: resolvedDependenciesChartData } =
           formatPieChartData(resolvedDependencies);

diff --git a/src/pages/Packages/Packages.tsx b/src/pages/Packages/Packages.tsx
@@ -202,7 +202,7 @@ const Packages = () => {
             scope: dependencyInfo.scope as DEPENDENCY_SCOPES,
             is_runtime: dependencyInfo.is_runtime,
             is_optional: dependencyInfo.is_optional,
-            is_resolved: dependencyInfo.is_resolved,
+            is_pinned: dependencyInfo.is_pinned,
             resolved_package: dependencyInfo.resolved_package || {},
             dependency_uid: dependencyInfo.dependency_uid,
             for_package_uid: dependencyInfo.for_package_uid,
@@ -572,7 +572,7 @@ const Packages = () => {
                                                     Optional
                                                   </Badge>
                                                 )}
-                                                {dependency.is_resolved && (
+                                                {dependency.is_pinned && (
                                                   <Badge
                                                     pill
                                                     bg="success"

diff --git a/src/pages/Packages/filters.ts b/src/pages/Packages/filters.ts
@@ -6,15 +6,15 @@ export interface DatasourceFilter {
 export interface DepFilterTag {
   value: string;
   label: string;
-  flag: "is_runtime" | "is_resolved" | "is_optional";
+  flag: "is_runtime" | "is_pinned" | "is_optional";
 }
 
 export const DepFilterTags: Record<
   "RUNTIME" | "RESOLVED" | "OPTIONAL",
   DepFilterTag
 > = {
   RUNTIME: { value: "runtime", label: "Runtime", flag: "is_runtime" },
-  RESOLVED: { value: "resolved", label: "Resolved", flag: "is_resolved" },
+  RESOLVED: { value: "resolved", label: "Resolved", flag: "is_pinned" },
   OPTIONAL: { value: "optional", label: "Optional", flag: "is_optional" },
 };
 export const DepFilterTagsList = [

diff --git a/src/pages/Packages/packageDefinitions.ts b/src/pages/Packages/packageDefinitions.ts
@@ -6,7 +6,7 @@ export interface DependencyDetails {
   scope: DEPENDENCY_SCOPES;
   is_runtime: boolean;
   is_optional: boolean;
-  is_resolved: boolean;
+  is_pinned: boolean;
   resolved_package: unknown;
   dependency_uid: string;
   for_package_uid: string | null;

diff --git a/src/services/importedJsonTypes.ts b/src/services/importedJsonTypes.ts
@@ -181,7 +181,7 @@ export interface Resource {
       scope: string | null;
       is_runtime: boolean;
       is_optional: boolean;
-      is_resolved: boolean;
+      is_pinned: boolean;
       resolved_package: unknown;
       extra_data: unknown;
     }[];

diff --git a/src/services/models/dependencies.ts b/src/services/models/dependencies.ts
@@ -24,7 +24,7 @@ export interface DependenciesAttributes {
   scope: string;
   is_runtime: boolean;
   is_optional: boolean;
-  is_resolved: boolean;
+  is_pinned: boolean;
   resolved_package: unknown;
   dependency_uid: string;
   for_package_uid: string;
@@ -60,7 +60,7 @@ export default function dependenciesModel(sequelize: Sequelize) {
       scope: DataTypes.STRING,
       is_runtime: DataTypes.BOOLEAN,
       is_optional: DataTypes.BOOLEAN,
-      is_resolved: DataTypes.BOOLEAN,
+      is_pinned: DataTypes.BOOLEAN,
       resolved_package: jsonDataType("resolved_package", {}),
       dependency_uid: DataTypes.STRING,
       for_package_uid: {

diff --git a/tests/test-scans/packages_dependencies/expectedPackagesDeps.ts b/tests/test-scans/packages_dependencies/expectedPackagesDeps.ts
@@ -150,7 +150,7 @@ export const PackageDepsSamples: {
                 scope: DEPENDENCY_SCOPES.DEVELOPMENT,
                 is_runtime: false,
                 is_optional: true,
-                is_resolved: true,
+                is_pinned: true,
                 resolved_package: {},
                 extra_data: {
                   is_editable: false,
@@ -171,7 +171,7 @@ export const PackageDepsSamples: {
                 scope: DEPENDENCY_SCOPES.DEVELOPMENT,
                 is_runtime: false,
                 is_optional: true,
-                is_resolved: true,
+                is_pinned: true,
                 resolved_package: {},
                 extra_data: {
                   is_editable: false,
@@ -192,7 +192,7 @@ export const PackageDepsSamples: {
                 scope: DEPENDENCY_SCOPES.DEVELOPMENT,
                 is_runtime: false,
                 is_optional: true,
-                is_resolved: true,
+                is_pinned: true,
                 resolved_package: {},
                 extra_data: {
                   is_editable: false,
@@ -332,7 +332,7 @@ export const PackageDepsSamples: {
         scope: DEPENDENCY_SCOPES.DEVELOPMENT,
         is_runtime: false,
         is_optional: true,
-        is_resolved: true,
+        is_pinned: true,
         resolved_package: {},
         dependency_uid:
           "pkg:pypi/[email protected]?uuid=faa3b45c-2e04-4891-b854-52ed459a6b0a",
@@ -347,7 +347,7 @@ export const PackageDepsSamples: {
         scope: DEPENDENCY_SCOPES.DEVELOPMENT,
         is_runtime: false,
         is_optional: true,
-        is_resolved: true,
+        is_pinned: true,
         resolved_package: {},
         dependency_uid:
           "pkg:pypi/[email protected]?uuid=b2cf6831-b0eb-4a30-98c3-3dac9202d639",
@@ -362,7 +362,7 @@ export const PackageDepsSamples: {
         scope: DEPENDENCY_SCOPES.DEVELOPMENT,
         is_runtime: false,
         is_optional: true,
-        is_resolved: true,
+        is_pinned: true,
         resolved_package: {},
         dependency_uid:
           "pkg:pypi/[email protected]?uuid=1c719652-292f-419c-a7a4-164c39296661",
@@ -442,7 +442,7 @@ export const PackageDepsSamples: {
             scope: DEPENDENCY_SCOPES.DEVELOPMENT,
             is_runtime: false,
             is_optional: true,
-            is_resolved: true,
+            is_pinned: true,
             resolved_package: {},
             extra_data: {
               is_editable: false,
@@ -463,7 +463,7 @@ export const PackageDepsSamples: {
             scope: DEPENDENCY_SCOPES.DEVELOPMENT,
             is_runtime: false,
             is_optional: true,
-            is_resolved: true,
+            is_pinned: true,
             resolved_package: {},
             extra_data: {
               is_editable: false,
@@ -484,7 +484,7 @@ export const PackageDepsSamples: {
             scope: DEPENDENCY_SCOPES.DEVELOPMENT,
             is_runtime: false,
             is_optional: true,
-            is_resolved: true,
+            is_pinned: true,
             resolved_package: {},
             extra_data: {
               is_editable: false,