Merge pull request #17 from contentstack/feat/DX-659-reinstall-method-implementation

Feat/dx 659 reinstall method implementation

Author: harshithad0703

.github/workflows/jira.yml

@@ -3,7 +3,7 @@ on:
   pull_request:
     types: [opened]
 jobs:
-  security:
+  security-jira:
     if: ${{ github.actor == 'dependabot[bot]' || github.actor == 'snyk-bot' || contains(github.event.pull_request.head.ref, 'snyk-fix-')  || contains(github.event.pull_request.head.ref, 'snyk-upgrade-')}}
     runs-on: ubuntu-latest
     steps:

.github/workflows/sast-scan.yml

@@ -0,0 +1,11 @@
+name: SAST Scan
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+jobs:
+  security-sast:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Semgrep Scan
+        run: docker run -v /var/run/docker.sock:/var/run/docker.sock -v "${PWD}:/src" returntocorp/semgrep semgrep scan --config auto

.github/workflows/sca-scan.yml

@@ -3,7 +3,7 @@ on:
   pull_request:
     types: [opened, synchronize, reopened]
 jobs:
-  security:
+  security-sca:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@master

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## [v1.1.0](https://github.com/contentstack/contentstack-marketplace-sdk/tree/v1.1.0) (2024-06-05)
+ - added reinstall app function
+
 ## [v1.0.2](https://github.com/contentstack/contentstack-marketplace-sdk/tree/v1.0.2) (2024-01-16)
  - Updated dependencies
 

lib/marketplace/app/index.js

@@ -144,6 +144,37 @@ export function App (http, data) {
         }
       }
 
+      /**
+       * @description The reinstall call is used to initiate the reinstallation of the app
+       * @memberof App
+       * @func reinstall
+       * @param {String} param.targetType - The target on which app needs to be reinstalled, stack or ogranization.
+       * @param {String} param.targetUid - The uid of the target, on which the app will be reinstalled
+       * @returns Promise<Reinstallation>
+       *
+       * @example
+       * import * as contentstack from '@contentstack/marketplace'
+       * const client = contentstack.client({ authtoken: 'TOKEN'})
+       * client.marketplace('organization_uid').app('manifest_uid').reinstall({ targetUid: 'STACK_API_KEY', targetType: 'stack' })
+       * .then((reinstallation) => console.log(installation))
+       */
+      this.reinstall = async ({ targetUid, targetType }) => {
+        try {
+          const headers = {
+            headers: { ...cloneDeep(this.params) }
+          } || {}
+
+          const response = await http.put(`${this.urlPath}/reinstall`, { target_type: targetType, target_uid: targetUid }, headers)
+          if (response.data) {
+            return new Installation(http, response.data, this.params) || {}
+          } else {
+            throw error(response)
+          }
+        } catch (err) {
+          throw error(err)
+        }
+      }
+
       /**
        * @description The upgrade call is used to upgrade the installation of an app
        * @memberof App

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/marketplace-sdk",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "The Contentstack Marketplace SDK is used to manage the content of your Contentstack marketplace apps",
   "main": "./dist/node/contentstack-marketplace.js",
   "browser": "./dist/web/contentstack-marketplace.js",

package.json

@@ -6,7 +6,7 @@ import { expect } from 'chai'
 
 dotenv.config()
 
-let stack = {}
+// let stack = {}
 const orgID = process.env.ORG_UID
 let client = {}
 let appUid = ''
@@ -190,4 +190,17 @@ describe('Apps api Test', () => {
       })
       .catch(done)
   })
+
+  it('should reinstall the app', done => {
+    client.marketplace(orgID).app(appUid).reinstall({ targetType: 'stack', targetUid: process.env.APIKEY })
+      .then((reinstallation) => {
+        expect(reinstallation.reinstallation_uid).to.not.equal(undefined)
+        expect(reinstallation.params.organization_uid).to.be.equal(orgID)
+        expect(reinstallation.fetch).to.not.equal(undefined)
+        expect(reinstallation.update).to.not.equal(undefined)
+        expect(reinstallation.uninstall).to.not.equal(undefined)
+        done()
+      })
+      .catch(done)
+  })
 })

test/api/app-test.js

@@ -192,6 +192,18 @@ export function installation(marketplace: Marketplace) {
                 done()
             }).catch(done)
         })
+        
+        test('should Reinstall App', done => {
+            marketplace.app(appUid).reinstall({targetType: 'stack', targetUid: process.env.APIKEY as string})
+            .then((reinstallation) => {
+                installationUid = reinstallation.installation_uid
+                expect(reinstallation.installation_uid).to.not.equal(undefined)
+                expect(reinstallation.fetch).to.not.equal(undefined)
+                expect(reinstallation.update).to.not.equal(undefined)
+                expect(reinstallation.uninstall).to.not.equal(undefined)
+                done()
+            }).catch(done)
+        })
 
         test('should Uninstall App installation', done => {
             marketplace.installation(installationUid).uninstall()

test/typescript/app.ts

@@ -303,6 +303,38 @@ describe('Contentstack apps test', () => {
         done()
       })
   })
+  it('should reinstall the app', done => {
+    const mock = new MockAdapter(Axios)
+    const uid = appMock.uid
+    // using same installation mock data for reinstall
+    mock.onPut(`/manifests/${uid}/reinstall`).reply(200, {
+      data: {
+        ...installationMock
+      }
+    })
+    const targetUid = 'target_uid'
+    const targetType = 'target_type'
+    makeApp({ data: { uid } })
+      .upgrade({ targetUid, targetType })
+      .then((reinstallation) => {
+        expect(reinstallation.status).to.be.equal(installationMock.status)
+        expect(reinstallation.manifest.name).to.be.equal(installationMock.manifest.name)
+        expect(reinstallation.target.uid).to.be.equal(installationMock.target.uid)
+        expect(reinstallation.organization_uid).to.be.equal(installationMock.organization_uid)
+        expect(reinstallation.uid).to.be.equal(installationMock.uid)
+      })
+      .catch(done)
+
+    // failing test when empty data is passed
+    mock.onPut(`/manifests/${uid}/reinstall`).reply(400, {})
+    makeApp({ data: { uid } })
+      .upgrade({ targetUid, targetType })
+      .then()
+      .catch((error) => {
+        expect(error).to.not.equal(null)
+        done()
+      })
+  })
 })
 
 function checkApp (app) {

test/unit/apps-test.js

@@ -20,6 +20,7 @@ export interface App extends SystemFields, SystemFunction<App> {
         redirectUri: string, 
         scope: string, 
         state: string }): Promise<AnyProperty>
+    reinstall(data: {targetUid: string, targetType: AppTarget}): Promise<Installation>
     authorization(): Authorization
     listInstallations(): Promise<ContentstackCollection<App>>
 }