fix: module with architecture (#843)

* fix: module with architecture * test: update test mock data & snapshots * test: update architecture filter test snapshot * fix: architecture types export * chore: mock data paths * docs: architecture related * chore: workspace config
hoonoh · May 16, 2024 · 95733bb · 95733bb
1 parent 10b025c
commit 95733bb
Show file tree

Hide file tree

Showing 9 changed files with 998,326 additions and 171,487 deletions.
diff --git a/README.md b/README.md
@@ -116,6 +116,14 @@ You can use `linux` or `windows` (all in lowercase) as wildcard.
 
 ###### _example `-p windows "Red Hat Enterprise Linux"`_
 
+##### --architectures | -a
+
+Instance architecture types to filter. Accepts multiple string values.
+
+###### _Default: "arm64","arm64_mac","i386","x86_64","x86_64_mac"_
+
+###### _example `-a arm64 x86_64`_
+
 ##### --limit | -l
 
 Limits list of price information items to be returned.
@@ -173,56 +181,73 @@ import { getGlobalSpotPrices } from 'aws-spot-price';
     minVCPU: 2,
     limit: 5,
     reduceAZ: true,
+    architectures: ['arm64', 'x86_64']
   });
   console.log(JSON.stringify(results, null, 2));
 })();
 ```
 
 #### Results
 
-```json[
+```json
+[
   {
     "availabilityZone": "us-east-2c",
-    "instanceType": "c5.large",
+    "instanceType": "t4g.medium",
     "platform": "Linux/UNIX",
-    "spotPrice": 0.019,
-    "timestamp": "2020-11-19T15:18:07.000Z",
+    "architectures": [
+      "arm64"
+    ],
+    "spotPrice": 0.0083,
+    "timestamp": "2024-05-16T10:31:10.000Z",
     "vCpu": 2,
     "memoryGiB": 4
   },
   {
-    "availabilityZone": "us-east-2c",
-    "instanceType": "c5a.large",
+    "availabilityZone": "us-west-2a",
+    "instanceType": "c7a.large",
     "platform": "Linux/UNIX",
-    "spotPrice": 0.019,
-    "timestamp": "2020-11-19T22:04:26.000Z",
+    "architectures": [
+      "x86_64"
+    ],
+    "spotPrice": 0.0103,
+    "timestamp": "2024-05-15T16:09:23.000Z",
     "vCpu": 2,
     "memoryGiB": 4
   },
   {
-    "availabilityZone": "us-east-2a",
-    "instanceType": "c5d.large",
+    "availabilityZone": "us-west-1b",
+    "instanceType": "c7i-flex.large",
     "platform": "Linux/UNIX",
-    "spotPrice": 0.019,
-    "timestamp": "2020-11-19T05:58:45.000Z",
+    "architectures": [
+      "x86_64"
+    ],
+    "spotPrice": 0.0108,
+    "timestamp": "2024-05-16T04:16:55.000Z",
     "vCpu": 2,
     "memoryGiB": 4
   },
   {
-    "availabilityZone": "us-east-2a",
-    "instanceType": "c5n.large",
+    "availabilityZone": "us-west-2d",
+    "instanceType": "m7a.large",
     "platform": "Linux/UNIX",
-    "spotPrice": 0.019,
-    "timestamp": "2020-11-20T02:27:24.000Z",
+    "architectures": [
+      "x86_64"
+    ],
+    "spotPrice": 0.0117,
+    "timestamp": "2024-05-16T00:47:33.000Z",
     "vCpu": 2,
-    "memoryGiB": 5.25
+    "memoryGiB": 8
   },
   {
-    "availabilityZone": "us-east-2b",
-    "instanceType": "c6g.large",
+    "availabilityZone": "us-west-2b",
+    "instanceType": "t3a.medium",
     "platform": "Linux/UNIX",
-    "spotPrice": 0.02,
-    "timestamp": "2020-11-19T13:41:03.000Z",
+    "architectures": [
+      "x86_64"
+    ],
+    "spotPrice": 0.0129,
+    "timestamp": "2024-05-16T09:02:05.000Z",
     "vCpu": 2,
     "memoryGiB": 4
   }

diff --git a/aws-spot-price.code-workspace b/aws-spot-price.code-workspace
@@ -11,7 +11,9 @@
     "prettier.prettierPath": ".yarn/sdks/prettier/index.js",
 
     // editor
-    "editor.codeActionsOnSave": { "source.fixAll.eslint": true },
+    "editor.codeActionsOnSave": {
+      "source.fixAll.eslint": "explicit"
+    },
     "editor.rulers": [100],
     "editor.tabSize": 2,
     "editor.formatOnSave": true,

diff --git a/package.json b/package.json
@@ -33,7 +33,7 @@
     "build:ec2-info": "ts-node -T scripts/generate-ec2-info.ts",
     "build:ec2-types": "ts-node -T scripts/generate-ec2-types.ts",
     "build:regions": "ts-node -T scripts/generate-regions.ts",
-    "build:types": "dts-bundle-generator -o dist/module.d.ts src/module.ts",
+    "build:types": "dts-bundle-generator -o dist/module.d.ts src/module.ts --external-inlines @aws-sdk/client-ec2",
     "build:cli": "yarn esbuild --outdir=./dist --platform=node --format=cjs --bundle --minify --main-fields=module,main --sources-content=false ./src/cli.ts",
     "build:module": "yarn esbuild --outdir=./dist --platform=node --format=cjs --bundle --minify --main-fields=module,main --sources-content=false ./src/module.ts",
     "build": "yarn build:cli && yarn build:module",

diff --git a/scripts/generate-spot-prices-mock-data.ts b/scripts/generate-spot-prices-mock-data.ts
@@ -18,7 +18,7 @@ const fetchData = async (region: Region, token?: string): Promise<void> => {
   if (results.NextToken) await fetchData(region, results.NextToken);
 };
 
-const jsonPath = resolve(__dirname, '../test/spot-prices-mock.json');
+const jsonPath = resolve(__dirname, '../test/data/spot-prices-mock.json');
 
 const { argv } = yargs()
   .scriptName('generate-spot-prices-mock')

diff --git a/src/lib/core.spec.ts b/src/lib/core.spec.ts
@@ -336,7 +336,7 @@ describe('lib', () => {
       beforeAll(async () => {
         restoreConsole = mockConsole();
         mockDefaultRegionEndpoints();
-        results = await getGlobalSpotPrices({ architectures: ['arm64'] });
+        results = await getGlobalSpotPrices();
       });
 
       afterAll(() => {

diff --git a/src/lib/core.ts b/src/lib/core.ts
@@ -442,6 +442,7 @@ export const getGlobalSpotPrices = async (options?: {
             if (instanceInfo) {
               rExtended.vCpu = instanceInfo.vCpu;
               rExtended.memoryGiB = instanceInfo.memoryGiB;
+              rExtended.architectures = instanceInfo.architectures;
             } else {
               // fetch intance info data from aws
               const region = rExtended.availabilityZone.match(/^.+\d/)?.[0];
@@ -456,14 +457,17 @@ export const getGlobalSpotPrices = async (options?: {
                 if (
                   desc[rExtended.instanceType] &&
                   desc[rExtended.instanceType].vCpu &&
-                  desc[rExtended.instanceType].memoryGiB
+                  desc[rExtended.instanceType].memoryGiB &&
+                  desc[rExtended.instanceType].architectures
                 ) {
                   ec2Info[rExtended.instanceType] = {
                     vCpu: desc[rExtended.instanceType].vCpu,
                     memoryGiB: desc[rExtended.instanceType].memoryGiB,
+                    architectures: desc[rExtended.instanceType].architectures,
                   };
                   rExtended.vCpu = desc[rExtended.instanceType].vCpu;
                   rExtended.memoryGiB = desc[rExtended.instanceType].memoryGiB;
+                  rExtended.architectures = desc[rExtended.instanceType].architectures;
                 }
               }
             }