From 7d32ca1fc8e63ec94ded4a846878840c99b59995 Mon Sep 17 00:00:00 2001
From: Prateek Surana <prateeksurana3255@gmail.com>
Date: Mon, 1 Jan 2024 15:06:50 +0530
Subject: [PATCH] docs: Updating Contributing Requirements (#116)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* 📝 Update the requirements in docs

* Update Changelog

* Add pre-commit hook workflow

* Apply formatting to all files in TestingApp
---
 .github/workflows/pre-commit-hook-run.yml     |  25 +
 CHANGELOG.md                                  |   2 +
 CONTRIBUTING.md                               |   7 +-
 TestingApp/.eslintrc.js                       |   4 -
 TestingApp/.prettierrc.js                     |   7 -
 TestingApp/App.js                             | 487 +++++++++---------
 .../async-storage.js                          |   4 +-
 TestingApp/__tests__/App-test.js              |  12 +-
 TestingApp/babel.config.js                    |   2 +-
 TestingApp/index.js                           |   6 +-
 TestingApp/metro.config.js                    |  16 +-
 examples/with-thirdparty/babel.config.js      |   8 +-
 package.json                                  |   4 +-
 13 files changed, 305 insertions(+), 279 deletions(-)
 create mode 100644 .github/workflows/pre-commit-hook-run.yml
 delete mode 100644 TestingApp/.eslintrc.js
 delete mode 100644 TestingApp/.prettierrc.js

diff --git a/.github/workflows/pre-commit-hook-run.yml b/.github/workflows/pre-commit-hook-run.yml
new file mode 100644
index 0000000..90ddb9c
--- /dev/null
+++ b/.github/workflows/pre-commit-hook-run.yml
@@ -0,0 +1,25 @@
+name: "Pre commit hook check"
+
+on:
+    pull_request:
+        types:
+            - opened
+            - reopened
+            - edited
+            - synchronize
+
+jobs:
+    pre-commit-check:
+        name: Pre commit hook check
+        runs-on: ubuntu-latest
+        container: rishabhpoddar/supertokens_website_sdk_testing_node_16
+        steps:
+            - uses: actions/checkout@v2
+            - run: git init && git add --all && git -c user.name='test' -c user.email='test@example.com' commit -m 'init for pr action'
+            - run: npm i --force || true
+            # the below command is there cause otherwise running npm run check-circular-dependencies gives an error like:
+            #   Your cache folder contains root-owned files, due to a bug in
+            #   npm ERR! previous versions of npm which has since been addressed.
+            - run: chown -R 1001:121 "/github/home/.npm"
+            - run: npm i --force
+            - run: ./hooks/pre-commit.sh
\ No newline at end of file
diff --git a/CHANGELOG.md b/CHANGELOG.md
index d2a45c9..2616365 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [unreleased]
+- Update contributing Prerequisites
+- Remove unused ESLint and Prettier config files from TestingApp
 
 ## [4.0.8] - 2023-09-26
 - use `URL` polyfill for `shouldDoInterceptionBasedOnUrl`: https://github.com/supertokens/supertokens-react-native/pull/111
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 40bf5a6..02489f4 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -14,7 +14,7 @@ We're so excited you're interested in helping with SuperTokens! We are happy to
 ## Development Setup  
 
 ### Prerequisites
-- Nodejs & npm
+- **Node.js v16.x** & npm
 - IDE: [VSCode](https://code.visualstudio.com/download)(recommended) or equivalent IDE  
 
 ### Project Setup
@@ -55,11 +55,12 @@ We're so excited you're interested in helping with SuperTokens! We are happy to
    cp -r ./test/tough-cookie ./node_modules/
    npm i git+https://github.com:<your username>/supertokens-react-native.git
    ```
-5. Navigate to `supertokens-react-native/TestingApp` and run all tests
+5. Add a static entry for `127.0.0.1   	localhost.org` in your `/etc/hosts` file
+6. Navigate to `supertokens-react-native/TestingApp` and run all tests
    ```
    INSTALL_PATH=../../supertokens-root npm test
    ```
-6. If all tests pass the output should be:
+7. If all tests pass the output should be:
 
    <img src="https://github.com/supertokens/supertokens-logo/blob/master/images/supertokens-react-native-tests-passing.png" alt="React Native tests passing" width="500px">
 
diff --git a/TestingApp/.eslintrc.js b/TestingApp/.eslintrc.js
deleted file mode 100644
index 40c6dcd..0000000
--- a/TestingApp/.eslintrc.js
+++ /dev/null
@@ -1,4 +0,0 @@
-module.exports = {
-  root: true,
-  extends: '@react-native-community',
-};
diff --git a/TestingApp/.prettierrc.js b/TestingApp/.prettierrc.js
deleted file mode 100644
index 84196d9..0000000
--- a/TestingApp/.prettierrc.js
+++ /dev/null
@@ -1,7 +0,0 @@
-module.exports = {
-  bracketSpacing: false,
-  jsxBracketSameLine: true,
-  singleQuote: true,
-  trailingComma: 'all',
-  arrowParens: 'avoid',
-};
diff --git a/TestingApp/App.js b/TestingApp/App.js
index d49805f..b3c10ef 100644
--- a/TestingApp/App.js
+++ b/TestingApp/App.js
@@ -6,244 +6,253 @@
  * @flow strict-local
  */
 
- import React from 'react';
- import {
-   View,
-   Text,
-   Button
- } from 'react-native';
- 
- import SuperTokens from "supertokens-react-native"
- import axios from "axios";
+import React from "react";
+import { View, Text, Button } from "react-native";
+
+import SuperTokens from "supertokens-react-native";
+import axios from "axios";
 SuperTokens.addAxiosInterceptors(axios);
 
-const BASE_URL = "http://192.168.1.100:8080/"
- 
- class App extends React.Component {
- 
-   constructor(props) {
-     super(props);
-     this.state = {
-       loggedIn: undefined,
-       sessionVerified: undefined
-     };
-   }
- 
-   render() {
-     if (this.state.loggedIn === undefined) {
-       return (
-         <View
-           style={{
-             flex: 1, backgroundColor: "#000000"
-           }} />
-       );
-     } else if (this.state.loggedIn) {
-       if (this.state.sessionVerified === undefined) {
-         return (
-           <View
-             style={{
-               flex: 1, backgroundColor: "#ff0000"
-             }} />
-         );
-       } else if (this.state.sessionVerified) {
-         return (
-           <View
-             style={{
-               flex: 1, alignItems: "center", justifyContent: "center"
-             }}>
-             <Text>
-               Logged in, session verification passed!
-             </Text>
-             <View style={{ height: 50 }} />
-             <Button
-               title="Verify Fetch"
-               onPress={this.sessionVerify} />
-             <View style={{ height: 50 }} />
-             <Button
-               title="Verify Axios"
-               onPress={this.sessionVerifyAxios} />
-             <View style={{ height: 50 }} />
-             <Button
-               title="Logout Fetch"
-               onPress={this.logout} />
-             <View style={{ height: 50 }} />
-             <Button
-               title="Logout Axios"
-               onPress={this.logoutAxios} />
-           </View>
-         )
-       } else {
-         return (
-           <View
-             style={{
-               flex: 1, alignItems: "center", justifyContent: "center"
-             }}>
-             <Text>
-               Logged in, session verification failed
-           </Text>
-           </View>
-         );
-       }
-     } else {
-       return (
-         <View
-           style={{
-             flex: 1, alignItems: "center", justifyContent: "center"
-           }}>
-           <Button
-             title="Login Fetch"
-             onPress={this.login} />
-           <View style={{ height: 50 }} />
-           <Button
-             title="Login Axios"
-             onPress={this.loginAxios} />
-         </View>
-       );
-     }
-   }
- 
-   logoutAxios = async () => {
-     let response = await axios.post(`${BASE_URL}logout`, {
-       withCredentials: true,
-     });
- 
-     this.setState(oldState => {
-       return {
-         ...oldState,
-         loggedIn: false
-       }
-     });
-   }
- 
-   sessionVerifyAxios = () => {
-     this.setState(oldState => {
-       return {
-         ...oldState,
-         sessionVerified: undefined
-       }
-     }, async () => {
-       let response = await axios.get(`${BASE_URL}`, {
-         withCredentials: true
-       });
- 
-       if (response.status === 440) {
-         this.logout();
-         return;
-       }
- 
-       let resText = await response.data;
-       this.setState(oldState => {
-         return {
-           ...oldState,
-           sessionVerified: resText === "rishabh"
-         }
-       });
-     });
-   }
- 
-   sessionVerify = () => {
-     this.setState(oldState => {
-       return {
-         ...oldState,
-         sessionVerified: undefined
-       }
-     }, async () => {
-       let response = await fetch(`${BASE_URL}`, {
-         method: "get",
-         credentials: "include"
-       });
- 
-       if (response.status === 440) {
-         this.logout();
-         return;
-       }
- 
-       let resText = await response.text();
-       this.setState(oldState => {
-         return {
-           ...oldState,
-           sessionVerified: resText === "rishabh"
-         }
-       });
-     });
-   }
- 
-   logout = async () => {
-     let response = await fetch(`${BASE_URL}logout`, {
-       method: "post",
-       credentials: "include",
-     });
- 
-     this.setState(oldState => {
-       return {
-         ...oldState,
-         loggedIn: false
-       }
-     });
-   }
- 
-   loginAxios = async () => {
-     let response = await axios.post(`${BASE_URL}login`, {
-       userId: "rishabh"
-     }, {
-         withCredentials: true
-       });
- 
-     this.setState(oldState => {
-       return {
-         ...oldState,
-         loggedIn: true
-       }
-     }, () => {
-       this.sessionVerify();
-     });
-   }
- 
-   login = async () => {
-     let response = await fetch(`${BASE_URL}login`, {
-       method: "post",
-       credentials: "include",
-       headers: {
-         'Content-Type': 'application/json'
-       },
-       body: JSON.stringify({
-         userId: "rishabh"
-       })
-     });
- 
-     this.setState(oldState => {
-       return {
-         ...oldState,
-         loggedIn: true
-       }
-     }, () => {
-       this.sessionVerify();
-     });
-   }
- 
-   componentDidMount() {
-     SuperTokens.init({
-       apiDomain: `${BASE_URL}`,
-       sessionExpiredStatusCode: 440,
-     })
-     this.checkLogin();
-   }
- 
-   checkLogin = async () => {
-     let loggedIn = await SuperTokens.doesSessionExist();
-     this.setState((oldState) => {
-       return {
-         ...oldState,
-         loggedIn
-       };
-     }, () => {
-       if (this.state.loggedIn) {
-         this.sessionVerify();
-       }
-     });
-   }
- 
- }
- 
- export default App;
- 
\ No newline at end of file
+const BASE_URL = "http://192.168.1.100:8080/";
+
+class App extends React.Component {
+    constructor(props) {
+        super(props);
+        this.state = {
+            loggedIn: undefined,
+            sessionVerified: undefined
+        };
+    }
+
+    render() {
+        if (this.state.loggedIn === undefined) {
+            return (
+                <View
+                    style={{
+                        flex: 1,
+                        backgroundColor: "#000000"
+                    }}
+                />
+            );
+        } else if (this.state.loggedIn) {
+            if (this.state.sessionVerified === undefined) {
+                return (
+                    <View
+                        style={{
+                            flex: 1,
+                            backgroundColor: "#ff0000"
+                        }}
+                    />
+                );
+            } else if (this.state.sessionVerified) {
+                return (
+                    <View
+                        style={{
+                            flex: 1,
+                            alignItems: "center",
+                            justifyContent: "center"
+                        }}
+                    >
+                        <Text>Logged in, session verification passed!</Text>
+                        <View style={{ height: 50 }} />
+                        <Button title="Verify Fetch" onPress={this.sessionVerify} />
+                        <View style={{ height: 50 }} />
+                        <Button title="Verify Axios" onPress={this.sessionVerifyAxios} />
+                        <View style={{ height: 50 }} />
+                        <Button title="Logout Fetch" onPress={this.logout} />
+                        <View style={{ height: 50 }} />
+                        <Button title="Logout Axios" onPress={this.logoutAxios} />
+                    </View>
+                );
+            } else {
+                return (
+                    <View
+                        style={{
+                            flex: 1,
+                            alignItems: "center",
+                            justifyContent: "center"
+                        }}
+                    >
+                        <Text>Logged in, session verification failed</Text>
+                    </View>
+                );
+            }
+        } else {
+            return (
+                <View
+                    style={{
+                        flex: 1,
+                        alignItems: "center",
+                        justifyContent: "center"
+                    }}
+                >
+                    <Button title="Login Fetch" onPress={this.login} />
+                    <View style={{ height: 50 }} />
+                    <Button title="Login Axios" onPress={this.loginAxios} />
+                </View>
+            );
+        }
+    }
+
+    logoutAxios = async () => {
+        let response = await axios.post(`${BASE_URL}logout`, {
+            withCredentials: true
+        });
+
+        this.setState(oldState => {
+            return {
+                ...oldState,
+                loggedIn: false
+            };
+        });
+    };
+
+    sessionVerifyAxios = () => {
+        this.setState(
+            oldState => {
+                return {
+                    ...oldState,
+                    sessionVerified: undefined
+                };
+            },
+            async () => {
+                let response = await axios.get(`${BASE_URL}`, {
+                    withCredentials: true
+                });
+
+                if (response.status === 440) {
+                    this.logout();
+                    return;
+                }
+
+                let resText = await response.data;
+                this.setState(oldState => {
+                    return {
+                        ...oldState,
+                        sessionVerified: resText === "rishabh"
+                    };
+                });
+            }
+        );
+    };
+
+    sessionVerify = () => {
+        this.setState(
+            oldState => {
+                return {
+                    ...oldState,
+                    sessionVerified: undefined
+                };
+            },
+            async () => {
+                let response = await fetch(`${BASE_URL}`, {
+                    method: "get",
+                    credentials: "include"
+                });
+
+                if (response.status === 440) {
+                    this.logout();
+                    return;
+                }
+
+                let resText = await response.text();
+                this.setState(oldState => {
+                    return {
+                        ...oldState,
+                        sessionVerified: resText === "rishabh"
+                    };
+                });
+            }
+        );
+    };
+
+    logout = async () => {
+        let response = await fetch(`${BASE_URL}logout`, {
+            method: "post",
+            credentials: "include"
+        });
+
+        this.setState(oldState => {
+            return {
+                ...oldState,
+                loggedIn: false
+            };
+        });
+    };
+
+    loginAxios = async () => {
+        let response = await axios.post(
+            `${BASE_URL}login`,
+            {
+                userId: "rishabh"
+            },
+            {
+                withCredentials: true
+            }
+        );
+
+        this.setState(
+            oldState => {
+                return {
+                    ...oldState,
+                    loggedIn: true
+                };
+            },
+            () => {
+                this.sessionVerify();
+            }
+        );
+    };
+
+    login = async () => {
+        let response = await fetch(`${BASE_URL}login`, {
+            method: "post",
+            credentials: "include",
+            headers: {
+                "Content-Type": "application/json"
+            },
+            body: JSON.stringify({
+                userId: "rishabh"
+            })
+        });
+
+        this.setState(
+            oldState => {
+                return {
+                    ...oldState,
+                    loggedIn: true
+                };
+            },
+            () => {
+                this.sessionVerify();
+            }
+        );
+    };
+
+    componentDidMount() {
+        SuperTokens.init({
+            apiDomain: `${BASE_URL}`,
+            sessionExpiredStatusCode: 440
+        });
+        this.checkLogin();
+    }
+
+    checkLogin = async () => {
+        let loggedIn = await SuperTokens.doesSessionExist();
+        this.setState(
+            oldState => {
+                return {
+                    ...oldState,
+                    loggedIn
+                };
+            },
+            () => {
+                if (this.state.loggedIn) {
+                    this.sessionVerify();
+                }
+            }
+        );
+    };
+}
+
+export default App;
diff --git a/TestingApp/__mocks__/@react-native-async-storage/async-storage.js b/TestingApp/__mocks__/@react-native-async-storage/async-storage.js
index 0bc2bcf..2051b5f 100644
--- a/TestingApp/__mocks__/@react-native-async-storage/async-storage.js
+++ b/TestingApp/__mocks__/@react-native-async-storage/async-storage.js
@@ -1,3 +1,3 @@
-import MockStorage from '@react-native-async-storage/async-storage/jest/async-storage-mock';
+import MockStorage from "@react-native-async-storage/async-storage/jest/async-storage-mock";
 
-export default MockStorage;
\ No newline at end of file
+export default MockStorage;
diff --git a/TestingApp/__tests__/App-test.js b/TestingApp/__tests__/App-test.js
index 1784766..14f7d5e 100644
--- a/TestingApp/__tests__/App-test.js
+++ b/TestingApp/__tests__/App-test.js
@@ -2,13 +2,13 @@
  * @format
  */
 
-import 'react-native';
-import React from 'react';
-import App from '../App';
+import "react-native";
+import React from "react";
+import App from "../App";
 
 // Note: test renderer must be required after react-native.
-import renderer from 'react-test-renderer';
+import renderer from "react-test-renderer";
 
-it('renders correctly', () => {
-  renderer.create(<App />);
+it("renders correctly", () => {
+    renderer.create(<App />);
 });
diff --git a/TestingApp/babel.config.js b/TestingApp/babel.config.js
index f842b77..651fc7d 100644
--- a/TestingApp/babel.config.js
+++ b/TestingApp/babel.config.js
@@ -1,3 +1,3 @@
 module.exports = {
-  presets: ['module:metro-react-native-babel-preset'],
+    presets: ["module:metro-react-native-babel-preset"]
 };
diff --git a/TestingApp/index.js b/TestingApp/index.js
index a850d03..881337a 100644
--- a/TestingApp/index.js
+++ b/TestingApp/index.js
@@ -2,8 +2,8 @@
  * @format
  */
 
-import {AppRegistry} from 'react-native';
-import App from './App';
-import {name as appName} from './app.json';
+import { AppRegistry } from "react-native";
+import App from "./App";
+import { name as appName } from "./app.json";
 
 AppRegistry.registerComponent(appName, () => App);
diff --git a/TestingApp/metro.config.js b/TestingApp/metro.config.js
index e91aba9..5868bfe 100644
--- a/TestingApp/metro.config.js
+++ b/TestingApp/metro.config.js
@@ -6,12 +6,12 @@
  */
 
 module.exports = {
-  transformer: {
-    getTransformOptions: async () => ({
-      transform: {
-        experimentalImportSupport: false,
-        inlineRequires: true,
-      },
-    }),
-  },
+    transformer: {
+        getTransformOptions: async () => ({
+            transform: {
+                experimentalImportSupport: false,
+                inlineRequires: true
+            }
+        })
+    }
 };
diff --git a/examples/with-thirdparty/babel.config.js b/examples/with-thirdparty/babel.config.js
index 2900afe..2b73c1b 100644
--- a/examples/with-thirdparty/babel.config.js
+++ b/examples/with-thirdparty/babel.config.js
@@ -1,6 +1,6 @@
 module.exports = function(api) {
-  api.cache(true);
-  return {
-    presets: ['babel-preset-expo'],
-  };
+    api.cache(true);
+    return {
+        presets: ["babel-preset-expo"]
+    };
 };
diff --git a/package.json b/package.json
index d855943..4a81be6 100644
--- a/package.json
+++ b/package.json
@@ -6,9 +6,9 @@
   "scripts": {
     "build-check": "cd lib && npx tsc -p tsconfig.json --skipLibCheck --noEmit",
     "build": "cd lib && npx tsc -p tsconfig.json --skipLibCheck && cd ../ && cd test/playground && npx tsc -p tsconfig.json",
-    "pretty": "npx prettier --write --config .prettierrc \"lib/ts/**/*.ts\" \"lib/build/**/*.js\" \"TestingApp/test/**/*.js\" \"examples/**/*.js\"",
+    "pretty": "npx prettier --write --config .prettierrc \"lib/ts/**/*.ts\" \"lib/build/**/*.js\" \"TestingApp/**/*.js\" \"examples/**/*.js\"",
     "build-pretty": "npm run build && npm run pretty",
-    "pretty-check": "npx prettier --check --config .prettierrc \"lib/ts/**/*.ts\" \"lib/build/**/*.js\" \"TestingApp/test/**/*.js\" \"examples/**/*.js\"",
+    "pretty-check": "npx prettier --check --config .prettierrc \"lib/ts/**/*.ts\" \"lib/build/**/*.js\" \"TestingApp/**/*.js\" \"examples/**/*.js\"",
     "set-up-hooks": "cp hooks/pre-commit.sh .git/hooks/pre-commit && chmod +x .git/hooks/pre-commit",
     "build-docs": "rm -rf ./docs && npx typedoc --out ./docs --tsconfig ./lib/tsconfig.json ./lib/ts/index.ts",
     "size": "size-limit"